Skip to main content

Get-IMUserPreference

SYNOPSIS​

Retrieves user preferences.

SYNTAX​

me (Default)​

Get-IMUserPreference [-Session <ImmichSession>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

id​

Get-IMUserPreference [-Session <ImmichSession>] -id <String[]> [-ProgressAction <ActionPreference>]
[<CommonParameters>]

DESCRIPTION​

Gets user interface and behavior preferences for a specific user.

EXAMPLES​

EXAMPLE 1​

Get-IMUserPreference -Id 'user-id'

Gets user preferences.

EXAMPLE 2​

Get-IMUserPreference

Retrevies Immich user preferences for the currently logged in user

PARAMETERS​

-Session​

Optional session object for multi-instance connections.

Type: ImmichSession
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-id​

User ID to get preferences for.

Type: String[]
Parameter Sets: id
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-ProgressAction​

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters​

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS​

OUTPUTS​

NOTES​

EDIT THIS DOC​

This page was auto-generated from the powershell command comment based help. To edit the content of this page, update the script file comment based help on github Github